docs/development/Building in Docker.md

   1 # Building with Docker
   2
   3 > **On Windows building with this method is not advised and should be used only if Windows Linux Subsystem can not be used. In all other cases all Windows users should be using Linux Subsystem (WSL) instead**
   4
   5 Building with [Docker](https://www.docker.com/) is remarkably easy: an isolated container will hold all the needed compilation tools so that they won't interfere with your system and you won't need to install and manage them by yourself. You'll only need to have Docker itself [installed](https://docs.docker.com/install/).
   6
   7 The first time that you'll run a build it will take a little more time than following executions since it will be building its base image first. Once this initial process is completed, the firmware will be always built immediately.
   8
   9 If you want to start from scratch - _even if that's rarely needed_ - delete the `inav-build` image on your system (`docker image rm inav-build`).
  10
  11 ## Linux
  12
  13 In the repo's root, run:
  14
  15 ```
  16 ./build.sh <TARGET>
  17 ```
  18
  19 Where `<TARGET>` must be replaced with the name of the target that you want to build. For example:
  20
  21 ```
  22 ./build.sh MATEKF405SE
  23 ```
  24
  25 Run the script with no arguments to get more details on its usage:
  26
  27 ```
  28 ./build.sh
  29 ```
  30
  31 ## Windows 10
  32
  33 Docker on Windows requires full paths for mounting volumes in `docker run` commands. For example: `c:\Users\pspyc\Documents\Projects\inav` becomes `//c/Users/pspyc/Documents/Projects/inav` .
  34 If you are getting error "standard_init_linux.go:219: exec user process caused: no such file or directory", make sure `\cmake\docker.sh` has lf (not crlf) line endings.
  35
  36 You'll have to manually execute the same steps that the build script does:
  37
  38 1. `docker build --build-arg USER_ID=1000 --build-arg GROUP_ID=1000 -t inav-build .`
  39    + This step is only needed the first time.
  40    + If GDB should be installed in the image, add argument '--build-arg GDB=yes'
  41 2. `docker run --rm -it -v <PATH_TO_REPO>:/src inav-build <TARGET>`
  42    + Where `<PATH_TO_REPO>` must be replaced with the absolute path of where you cloned this repo (see above), and `<TARGET>` with the name of the target that you want to build.
  43
  44 3. If you need to update `Settings.md`, run:
  45
  46 `docker run --entrypoint /src/cmake/docker_docs.sh --rm -it -v <PATH_TO_REPO>:/src inav-build`
  47
  48 4. Building SITL:
  49
  50 `docker run --rm --entrypoint /src/cmake/docker_build_sitl.sh -it -v <PATH_TO_REPO>:/src inav-build`
  51
  52 5. Running SITL:
  53
  54 `docker run -p 5760:5760 -p 5761:5761 -p 5762:5762 -p 5763:5763 -p 5764:5764 -p 5765:5765 -p 5766:5766 -p 5767:5767 --entrypoint /src/cmake/docker_run_sitl.sh --rm -it -v <PATH_TO_REPO>:/src inav-build`.
  55    + SITL command line parameters can be adjusted in `cmake/docker_run_sitl.sh`.
  56
  57 Refer to the [Linux](#Linux) instructions or the [build script](/build.sh) for more details.